/*
 * Copyright (c) 2007 Aleksey Nikiforov
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 * * Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 *
 * * Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 *
 * * Neither the name of 'Aleksey Nikiforov' nor the names of other contributors 
 *   may be used to endorse or promote products derived from this software 
 *   without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package org.lex.input.mouse.component;

import com.jme.scene.Spatial;



/**
 * 
 * @author lex
 *
 */
public interface AdvancedMouse extends BasicMouse {

	/**
	 * @return true if mouse can move, false otherwise
	 */
	public boolean isActive();

	/**
	 * @return true if cursor is visible, false otherwise
	 */
	public boolean isCursorVisible();

	/**
	 * Making the mouse active will cause it to recieve input events
	 * and update it's hotSpotPosition.
	 * @param active
	 */
	public void setActive(boolean active);

	/**
	 * You can make cursor visible or invisible using this method.
	 * @param visible
	 */
	public void setCursorVisible(boolean visible);
	
	public float getSensitivity();
	public void setSensitivity(float sensitivity);
	
	/**
	 * Used when display resolution changes to update the mouse boundaries.
	 */
	public void reinit(int width, int height);
	
	public Spatial getMouseSpatial();
	public float getWidth();
	public float getHeight();
}